Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Reference Overview Page #6378

Merged
merged 4 commits into from
Oct 30, 2023
Merged

Adds Reference Overview Page #6378

merged 4 commits into from
Oct 30, 2023

Conversation

brianjo
Copy link
Collaborator

@brianjo brianjo commented Oct 24, 2023

This draft PR creates a home page for the Reference section of the React documentation. The purpose of this page is to provide a scannable overview of the documentation and make it easier for readers to get to the information they are looking for. The key feature is that it allows for the hooks section to be closed by default so the rest of the documentation is accessible from the Reference landing page.

The PR does the following.

  • Creates a new overview page, which was renamed to index.md
  • Renames the current index.md file to hooks.md
  • Updates the left navigation to include the new page at the top.
Screenshot 2023-10-24 at 4 34 52 PM

@github-actions
Copy link

github-actions bot commented Oct 24, 2023

Size changes

📦 Next.js Bundle Analysis for react-dev

This analysis was generated by the Next.js Bundle Analysis action. 🤖

One Page Changed Size

The following page changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/[[...markdownPath]] 78.92 KB (🟡 +15 B) 182.66 KB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 10% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

@brianjo brianjo marked this pull request as ready for review October 26, 2023 04:32
Copy link
Contributor

@lunaleaps lunaleaps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! I tried to see if there was a way for git to mark the move, but it seems to be more Github auto-detection?

@brianjo brianjo merged commit 81f1520 into reactjs:main Oct 30, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants